home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / MrmRegisterNamesInHierarchy.z / MrmRegisterNamesInHierarchy
Text File  |  1998-10-30  |  8KB  |  133 lines
  1.  
  2.  
  3.  
  4.      MMMMrrrrmmmmRRRReeeeggggiiiisssstttteeeerrrrNNNNaaaammmmeeeessssIIIInnnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyUUUU((((NNNN3333IIIIXXXXXXXX))))SSSSyyyyssssttttMMMMeeeerrrrmmmmmmmmRRRRVVVVeeeeggggiiiisssstttteeeerrrrNNNNaaaammmmeeeessssIIIInnnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           MMMMrrrrmmmmRRRReeeeggggiiiisssstttteeeerrrrNNNNaaaammmmeeeessssIIIInnnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy - Registers the values
  10.           associated with the names referenced in UIL within a single
  11.           hierarchy (for example, UIL callback function names or UIL
  12.           identifier names)
  13.  
  14.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  15.           #include <Mrm/MrmPublic.h>
  16.           CCCCaaaarrrrddddiiiinnnnaaaallll MMMMrrrrmmmmRRRReeeeggggiiiisssstttteeeerrrrNNNNaaaammmmeeeessssIIIInnnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy(
  17.           MMMMrrrrmmmmHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy hhhhiiiieeeerrrraaaarrrrcccchhhhyyyy____iiiidddd,
  18.           MMMMrrrrmmmmRRRReeeeggggiiiisssstttteeeerrrrAAAArrrrgggglllliiiisssstttt rrrreeeeggggiiiisssstttteeeerrrr____lllliiiisssstttt,
  19.           MMMMrrrrmmmmCCCCoooouuuunnnntttt rrrreeeeggggiiiisssstttteeeerrrr____ccccoooouuuunnnntttt);
  20.  
  21.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  22.           This page documents Motif 2.1.
  23.  
  24.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  25.           The MMMMrrrrmmmmRRRReeeeggggiiiisssstttteeeerrrrNNNNaaaammmmeeeessssIIIInnnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyfunction registers a vector
  26.           of names and associated values for access in MRM.  The
  27.           values can be callback functions, pointers to user-defined
  28.           data, or any other values.  The information provided is used
  29.           to resolve symbolic references occurring in UID files to
  30.           their run-time values. For callbacks, this information
  31.           provides the procedure address required by the Motif
  32.           Toolkit.  For names used as identifiers in UIL, this
  33.           information provides any run-time mapping the application
  34.           needs.
  35.  
  36.           This function is similar to MMMMrrrrmmmmRRRReeeeggggiiiisssstttteeeerrrrNNNNaaaammmmeeeessss, except that
  37.           the scope of the names registered by
  38.           MMMMrrrrmmmmRRRReeeeggggiiiisssstttteeeerrrrNNNNaaaammmmeeeessssIIIInnnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyis limited to the hierarchy
  39.           specified by _h_i_e_r_a_r_c_h_y__i_d, whereas the names registered by
  40.           MMMMrrrrmmmmRRRReeeeggggiiiisssstttteeeerrrrNNNNaaaammmmeeeesssshave global scope.  When MRM looks up a
  41.           name, it first tries to find the name among those registered
  42.           for the given hierarchy.  If that lookup fails, it tries to
  43.           find the name among those registered globally.
  44.  
  45.           _h_i_e_r_a_r_c_h_y__i_d
  46.                     Specifies the hierarchy with which the names are
  47.                     to be associated.
  48.  
  49.           _r_e_g_i_s_t_e_r__l_i_s_t
  50.                     Specifies a list of name/value pairs for the names
  51.                     to be registered.  Each name is a case-sensitive,
  52.                     NULL-terminated ASCII string.  Each value is a
  53.                     32-bit quantity, interpreted as a procedure
  54.                     address if the name is a callback function, and
  55.                     uninterpreted otherwise.
  56.  
  57.           _r_e_g_i_s_t_e_r__c_o_u_n_t
  58.                     Specifies the number of entries in _r_e_g_i_s_t_e_r__l_i_s_t.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                         (printed 10/24/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      MMMMrrrrmmmmRRRReeeeggggiiiisssstttteeeerrrrNNNNaaaammmmeeeessssIIIInnnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyUUUU((((NNNN3333IIIIXXXXXXXX))))SSSSyyyyssssttttMMMMeeeerrrrmmmmmmmmRRRRVVVVeeeeggggiiiisssstttteeeerrrrNNNNaaaammmmeeeessssIIIInnnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           The names in the list are case-sensitive.  The list can be
  75.           either ordered or unordered.
  76.  
  77.           Callback functions registered through
  78.           MMMMrrrrmmmmRRRReeeeggggiiiisssstttteeeerrrrNNNNaaaammmmeeeessssIIIInnnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyycan be either regular or creation
  79.           callbacks.  Regular callbacks have declarations determined
  80.           by Motif Toolkit and user requirements.  Creation callbacks
  81.           have the same format as any other callback:
  82.  
  83.           vvvvooooiiiidddd CCCCaaaallllllllBBBBaaaacccckkkkPPPPrrrroooocccc(
  84.           WWWWiiiiddddggggeeeetttt ****wwwwiiiiddddggggeeeetttt____iiiidddd,
  85.           OOOOppppaaaaqqqquuuueeee ttttaaaagggg,
  86.           XXXXmmmmAAAAnnnnyyyyCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt ****ccccaaaallllllllbbbbaaaacccckkkk____ddddaaaattttaaaa);
  87.  
  88.           _w_i_d_g_e_t__i_d Specifies the widget ID associated with the widget
  89.                     performing the callback (as in any callback
  90.                     function).
  91.  
  92.           _t_a_g       Specifies the tag value (as in any callback
  93.                     function).
  94.  
  95.           _c_a_l_l_b_a_c_k__d_a_t_a
  96.                     Specifies a widget-specific data structure.  This
  97.                     data structure has a minimum of two members: event
  98.                     and reason.  The reason member is always set to
  99.                     MMMMrrrrmmmmCCCCRRRR____CCCCRRRREEEEAAAATTTTEEEE.
  100.  
  101.           Note that the widget name and parent are available from the
  102.           widget record accessible through _w_i_d_g_e_t__i_d.
  103.  
  104.      RRRREEEETTTTUUUURRRRNNNN
  105.           This function returns one of the following status return
  106.           constants:
  107.  
  108.           MMMMrrrrmmmmSSSSUUUUCCCCCCCCEEEESSSSSSSS
  109.                     The function executed successfully.
  110.  
  111.           MMMMrrrrmmmmFFFFAAAAIIIILLLLUUUURRRREEEE
  112.                     The function failed.
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                         (printed 10/24/98)
  130.  
  131.  
  132.  
  133.